﻿// <copyright file="DebugDynamicMessage.cs" company="TenneySoftware">
// Copyright (c) 2009 All Right Reserved
// </copyright>
// <author>Robert Tenney</author>
// <email>rob10e@yahoo.com</email>
// <date>10/6/2009</date>
// <summary>Class for holding the data for describing the dynamic messages.</summary>

// License:

// Product: Engine.csproj
// Author: Robert N. Tenney
// Copyright: 10/6/2009

// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation version 2
// of the License.

// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

// This license covers all source code, binaries, and other materials related to this project
// unless specifically stated otherwise.

using System;
using System.Collections.Generic;

namespace TenneySoftware.Engine.Debug {
    /// <summary>
    /// Class for holding the data for describing the dynamic messages.
    /// </summary>
    public class DebugDynamicMessage {
        /// <summary>
        /// Name of the mode.
        /// </summary>
        private string name;
        
        /// <summary>
        /// Message that requires updating.
        /// </summary>
        private string message;
        
        /// <summary>
        /// Priority of the message.
        /// </summary>
        private int priority;
        
        /// <summary>
        /// Position on the screen to place the message.
        /// </summary>
        private Position position;

        /// <summary>
        /// Initializes a new instance of the DebugDynamicMessage class.
        /// </summary>
        /// <param name="name">The message's name.</param>
        /// <param name="message">The message.</param>
        /// <param name="priority">The message's priority.</param>
        /// <param name="position">The message's position on the screen.</param>
        public DebugDynamicMessage(string name, string message, int priority, Position position) {
            this.name = name;
            this.message = message;
            this.priority = priority;
            this.position = position;
        }

        /// <summary>
        /// Gets or sets the message's name.
        /// </summary>
        /// <value>
        /// The message's name.
        /// </value>
        public string Name {
            get {
                return this.name;
            }

            set {
                this.name = value;
            }
        }

        /// <summary>
        /// Gets or sets the message.
        /// </summary>
        /// <value>
        /// The message.
        /// </value>
        public string Message {
            get {
                return this.message;
            }

            set {
                this.message = value;
            }
        }

        /// <summary>
        /// Gets or sets the message's priority.
        /// </summary>
        /// <value>
        /// The message's priority.
        /// </value>
        public int Priority {
            get {
                return this.priority;
            }

            set {
                this.priority = value;
            }
        }

        /// <summary>
        /// Gets or sets the message's position.
        /// </summary>
        /// <value>
        /// The message's position.
        /// </value>
        public Position Position {
            get {
                return this.position;
            }

            set {
                this.position = value;
            }
        }
    }
}
